EoLCarePlan Tabular View
COCD_TP146077GB01 | |
EoLCarePlan |
This template class constrains the CDA Act class. This class represents the End of Life (EoL) care plan. |
Used by: | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="PCPR" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as patient care provision. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="INT" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as intended patient care. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:EoLCDAObservationType } ) { Fixed="EOLCP" } |
Model Attribute Description The HL7 attribute code uses a code from the EoLCDAObservationType to describe this class as an End of Life care plan. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] effectiveTime (IVL<TS>) |
Model Attribute Description
The HL7 attribute effectiveTime defines the time period during which the End of Life care plan is valid. Implementation in XML Instance The Interval of Points in Time data type flavour is used to carry this information in the XML element effectiveTime using the value attributes of the of the XML elements low and high. The date range shall be carried as follows: The XML attribute value of the XML elements low and high, shall be populated with a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.
The XML attribute value of the XML elements low and high should be populated to the level of detail that is available on the sending system. |
[1..1] [M] id (II) |
Model Attribute Description Implementation in XML Instance The Identifier Global data type flavour is used to carry this information in the XML element id as follows:
|
[1..1] [M] statusCode (CS { CNE:ActStatus } ) { Fixed="active" } |
Model Attribute Description The HL7 attribute code uses a code to describe the status of the End of Life care plan. Implementation in XML Instance The Coded Simple (CS) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#EoLCarePlan" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[0..1] author |
This template class constrains the CDA author class. The author of this End of Life Care Plan must be included if the author is different to the document (inherited) author. If there is no known author for the information held on the source system then:
|
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUT" } |
Model Attribute Description The HL7 attribute typeCode describes this class as an author participation. Implementation in XML Instance
|
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } |
Model Attribute Description The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent act are conducted across to the child act (also associated with the child act). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd in the actRelationships is set to "true". The value of this attribute is fixed in the HL7 model to "OP":
Implementation in XML Instance
|
[1..1] [M] contentId (II) { "NPFIT-000192#Role" } |
Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at run time with a value from the allowed list contained in the model.
|
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } ) { Fixed="OA" } |
Model Attribute Description The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author Implementation in XML Instance
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#author" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] time (TS) |
Model Attribute Description The HL7 attribute time is used to define the time the author originally recorded the End of Life Care Plan. Implementation in XML Instance The XML attribute value of the XML element time shall be populated with the time that author recorded the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present. Where no time is recorded or available then:
|
[1..1] participant (AuthorChoice) |
A link to the choice of author templates. |
[0..1] author1 |
This template class constrains the CDA author class. The author of the End of Life care plan is the person who updates the information on the End of Life system. The author of this information must be included if the author and/or date of authoring are different to those for the document (inherited) author. If there is no known author for the information held on the source system then:
|
[1..1] [M] typeCode (CS { CNE: ParticipationType } ) { Fixed="AUT" } |
Model Attribute Description The HL7 attribute typeCode describes this class as an author participation. Implementation in XML Instance The XML attribute typeCode is fixed to "AUT". |
[1..1] [M] contextControlCode (CS { CNE: ContextControl } ) { Fixed="OP" } |
Model Attribute Description The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct. The conduction can only take place if the contextConductionInd in the actRelationships is set to "true". The value of this attribute is fixed in the HL7 model to "OP":
Implementation in XML Instance
|
[1..1] [M] contentId (II) { "NPFIT-000192#Role" } |
Model Attribute Description The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use. The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.
|
[1..1] [M] functionCode (CV { CNE:AuthorFunctionType } ) { Fixed="LA" } |
Model Attribute Description The HL7 attribute functionCode uses a code from the vocabulary AuthorFunctionType to describe the function of the author Implementation in XML Instance
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#author1" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.
|
[1..1] [M] time (TS) |
Model Attribute Description The HL7 attribute time is used to define the time the author updated the End of life information. Implementation in XML Instance The XML attribute value of the XML element time shall be populated with the time that author updated the information using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present. |
[1..1] participant (AuthorChoice) |
A link to the choice of authors. |
[0..1] entryRelationship1 |
This template class constrains the CDA entryRelationship entry class.
This class is an entryRelationship class used to link the End of Life care plan to the care funding details. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#entryRelationship1" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.
|
[1..1] careFundingDetails (CareFundingDetails) |
A link to care funding details. |
[0..1] entryRelationship2 |
This template class constrains the CDA entryRelationship entry class.
This class is an entryRelationship class used to link the End of Life care plan to its review date. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance The XML attribute typeCode is fixed to "COMP". |
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance The XML attribute contextConductionInd is fixed to "true". |
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description The XML attribute seperatableInd is fixed to "false". |
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#entryRelationship2" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.
|
[1..1] plannedReviewDate (PlannedReviewDate) |
A link to the planned review date. |
[0..1] entryRelationship3 |
This template class constrains the CDA entryRelationship entry class. This class is an entryRelationship class used to link the End of Life care plan to its plan agreement text. |
[1..1] [M] typeCode (CS { CNE: ActRelationshipType } ) { Fixed="COMP" } |
Model Attribute Description The HL7 attribute typeCode uses a code to describe this class as a component. Implementation in XML Instance
|
[1..1] [M] contextConductionInd (BL) { Fixed="true" } |
Model Attribute Description The HL7 attribute contextConductionInd uses a Boolean value (true or false) to determine whether information associated with the parent section is conducted across to the child section (also associated with the child section). Implementation in XML Instance
|
[1..1] [M] seperatableInd (BL) { Fixed="false" } |
Model Attribute Description
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#entryRelationship3" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.
|
[1..1] planAgreementText (PlanAgreementText) |
A link to the plan agreement text. |
AuthorChoice |
Refers to the choice of authors of the End of Life care plan. |
Used by: EoLCarePlan | |
[1..1] : Template1 |
A link to the choice of author templates. |
PlannedReviewDate |
This template class constrains the CDA Observation class. Date the End of Life care plan is due for review. This date is set at creation of the End of Life care plan by a professional, in consultation with the patient. |
Used by: EoLCarePlan | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance The XML attribute classCode is fixed to "OBS". |
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an observation event. Implementation in XML Instance The XML attribute moodCode is fixed to "EVN". |
[1..1] [M] code (CV { CNE:EoLCDAObservationType } ) { Fixed="EOLPRD" } |
Model Attribute Description The HL7 attribute code uses a code from the EoLCDAObservationType to describe this class being used to record review date of End of Life care plan. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#plannedReviewDate" } |
Model Attribute Description The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.
|
[1..1] [M] value (TS) |
Model Attribute Description The HL7 attribute value is used to indicate when the End of Life care plan is to be reviewed. Implementation in XML Instance The XML attribute value of the XML element value shall be populated with the time the End of Life care plan should be reviewed using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:
Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present. |
CareFundingDetails |
This template class constrains the CDA Observation class. A class to record the funding source and any associated conditions or limitations. |
Used by: EoLCarePlan | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:EoLCDAObservationType } ) { Fixed="EOLCFD" } |
Model Attribute Description The HL7 attribute code uses a code from the EoLCDAObservationType to describe this class as an care funding details. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#careFundingDetails" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (ST) |
Model Attribute Description The HL7 attribute value is used to carry the care funding details. The XML element value should be populated using the ST data type as follows:
|
PlanAgreementText |
This template class constrains the CDA Observation class. This class captures whether the patient or carer has agreed to the content of the entire plan or individual aspects of treatment, expected outcomes, risks and alternative treatments. It also captures if agreement cannot be obtained and the reason for this. |
Used by: EoLCarePlan | |
[1..1] [M] classCode (CS { CNE: ActClass } ) { Fixed="OBS" } |
Model Attribute Description The HL7 attribute classCode uses a code to describe this class as an observation. Implementation in XML Instance
|
[1..1] [M] moodCode (CS { CNE: ActMood } ) { Fixed="EVN" } |
Model Attribute Description The HL7 attribute moodCode uses a code to describe this class as an event. Implementation in XML Instance
|
[1..1] [M] code (CV { CNE:CDAObservationType } ) { Fixed="PAPC" } |
Model Attribute Description The HL7 attribute code uses a code from the CDAObservationType vocabulary to describe the plan agreed with patient carer. Implementation in XML Instance The Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:
|
[1..1] [M] templateId (II) { Fixed="COCD_TP146077GB01#planAgreementText" } |
Model Attribute Description
The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use. Implementation in XML Instance The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
|
[1..1] [M] value (ST) |
Model Attribute Description The HL7 attribute value is used to carry the care plan agreement text. The XML element value should be populated using the ST data type as follows:
|